Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-02

oracle.AWXML
Class CubeDimensionSourceExpression

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.ExternalSourceExpression
              |
              +--oracle.AWXML.RestrictedSourceExpression
                    |
                    +--oracle.AWXML.CubeDimensionSourceExpression

public class CubeDimensionSourceExpression
extends RestrictedSourceExpression

A RestrictedSourceExpression that maps a Dimension, or one or more Level objects of a Dimension, for a Cube to columns in a relational table. The mapping relates the foreign key columns in a relational fact table to the Dimension or Level objects. A CubeDimensionSourceExpression is owned by a CubeMapGroup.

A CubeDimensionSourceExpression can map one or more Level objects of a Dimension. You can limit the rows in the source columns by using the methods inherited from RestrictedSourceExpression.

Typically, an application creates a CubeDimensionSourceExpression using factory methods. For example, the following code creates a CubeDimensionSourceExpression. In the example, the globalAW object is an AW.

 Cube cube = globalAW.createCube();
 CubeMapGroup cubeMapGroup = cube.createSourceCubeMapGroup();
 CubeDimensionSourceExpression cubeDimSourceExp = cubeMapGroup.CreateKeyMap();

After creating the CubeDimensionSourceExpression, use the setDimension method to specify a Dimension or the addLevel method to specify one or more Level objects. Use the CreateSourceColumn method create a SourceColumn object to specify a column for the Dimension or for each Level.

See Also:
MappingGroup

Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL

 

Constructor Summary
CubeDimensionSourceExpression(BaseObject input)
          Creates a CubeDimensionSourceExpression for the specified CubeMapGroup.

 

Method Summary
 void addLevel(Level input)
          Adds the specified Level to the CubeDimensionSourceExpression.
 java.lang.String Alter(AWConnection connection)
          Alters the CubeDimensionSourceExpression in the current analytic workspace of the specified database connection.
 java.lang.String Create(AWConnection connection)
          Creates a CubeDimensionSourceExpression in the current analytic workspace of the specified database connection.
 java.lang.String Delete(AWConnection connection)
          Deletes the CubeDimensionSourceExpression from the current analytic workspace of the specified database connection.
 Dimension getDimension()
          Gets the Dimension associated with the CubeDimensionSourceExpression.
 java.util.Vector getLevels()
          Gets the list of Level objects associated with the CubeDimensionSourceExpression.
 void setDimension(Dimension input)
          Specifies the Dimension to associate with the CubeDimensionSourceExpression.
 java.lang.String WriteToXML()
          Gets an XML representation of the CubeDimensionSourceExpression.

 

Methods inherited from class oracle.AWXML.RestrictedSourceExpression
createRestriction, getRestriction, getWhereClause, setRestriction, setWhereClause

 

Methods inherited from class oracle.AWXML.ExternalSourceExpression
addSourceColumn, CreateSourceColumn, getSourceColumns, getTargetObject, removeSourceColumn, setTargetObject

 

Methods inherited from class oracle.AWXML.BaseObject
CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

CubeDimensionSourceExpression

public CubeDimensionSourceExpression(BaseObject input)
Creates a CubeDimensionSourceExpression for the specified CubeMapGroup.
Parameters:
input - The CubeMapGroup to own the CubeDimensionSourceExpression.

Method Detail

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the CubeDimensionSourceExpression.
Overrides:
WriteToXML in class RestrictedSourceExpression
Returns:
An XML String that represents the CubeDimensionSourceExpression.

addLevel

public void addLevel(Level input)
Adds the specified Level to the CubeDimensionSourceExpression.
Parameters:
input - A Level for which you want to map a source column.

getLevels

public java.util.Vector getLevels()
Gets the list of Level objects associated with the CubeDimensionSourceExpression. If no Level objects are associated with the CubeDimensionSourceExpression, then this method returns null.
Returns:
A Vector that contains the Level objects associated with the CubeDimensionSourceExpression.

setDimension

public void setDimension(Dimension input)
Specifies the Dimension to associate with the CubeDimensionSourceExpression. The Dimension must have unique members so that the isNativeKeyUnique() method of the Dimension returns true.
Parameters:
input - The Dimension for which you want to map a source column.

getDimension

public Dimension getDimension()
Gets the Dimension associated with the CubeDimensionSourceExpression. If no Dimension is associated with the CubeDimensionSourceExpression, then this method returns null.
Returns:
The Dimension associated with the CubeDimensionSourceExpression.

Create

public java.lang.String Create(AWConnection connection)
Creates a CubeDimensionSourceExpression in the current analytic workspace of the specified database connection.
Overrides:
Create in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
A String that contains Success if the method creates the CubeDimensionSourceExpression.

Alter

public java.lang.String Alter(AWConnection connection)
Alters the CubeDimensionSourceExpression in the current analytic workspace of the specified database connection.
Overrides:
Alter in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
A String that contains Success if the method alters the CubeDimensionSourceExpression.

Delete

public java.lang.String Delete(AWConnection connection)
Deletes the CubeDimensionSourceExpression from the current analytic workspace of the specified database connection.
Overrides:
Delete in class BaseObject
Parameters:
connection - The AWConnection that specifies the database connection.
Returns:
A String that contains Success if the method deletes the CubeDimensionSourceExpression.

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-02

Copyright © 2003, 2005 Oracle. All rights reserved.